These are the options for the assistant's transcriber.
AssemblyAITranscriber
AzureSpeechTranscriber
CustomTranscriber
DeepgramTranscriber
ElevenLabsTranscriber
GladiaTranscriber
GoogleTranscriber
SpeechmaticsTranscriber
TalkscriberTranscriber
OpenAITranscriber
CartesiaTranscriber
Show child attributes
model
Anthropic · object
These are the options for the assistant's LLM.
Anthropic
Anyscale
Cerebras
CustomLLM
DeepInfra
DeepSeek
Google
Groq
InflectionAI
OpenAI
OpenRouter
PerplexityAI
Together
XAI
Show child attributes
voice
AzureVoice · object
These are the options for the assistant's voice.
AzureVoice
CartesiaVoice
CustomVoice
DeepgramVoice
ElevenLabsVoice
HumeVoice
LMNTVoice
NeuphonicVoice
OpenAIVoice
PlayHTVoice
RimeAIVoice
SmallestAIVoice
TavusVoice
cozmoxVoice
SesameVoice
InworldVoice
Show child attributes
firstMessage
string
This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
Example:
"Hello! How can I help you today?"
firstMessageInterruptionsEnabled
boolean
default:false
firstMessageMode
enum<string>
This is the mode for the first message. Default is 'assistant-speaks-first'.
Use:
'assistant-speaks-first' to have the assistant speak first.
'assistant-waits-for-user' to have the assistant wait for the user to speak first.
'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (assistant.model.messages at call start, call.messages at squad transfer points).
These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].
This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.
You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.
Google
OpenAI
Twilio
cozmox
Show child attributes
clientMessages
enum<string>[]
These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.
These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.
How many seconds of silence to wait before ending the call. Defaults to 30.
@default 30
Required range: 10 <= x <= 3600
Example:
30
maxDurationSeconds
number
This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
@default 600 (10 minutes)
Required range: 10 <= x <= 43200
Example:
600
backgroundSound
enum<string>string<uri>
This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
You can also provide a custom sound by providing a URL to an audio file.
Available options:
off,
office
Example:
"office"
backgroundDenoisingEnabled
boolean
deprecated
This enables filtering of noise and background speech while the user is talking.
Default false while in beta.
@default false
Example:
false
modelOutputInMessagesEnabled
boolean
This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
Default false while in beta.
@default false
Example:
false
transportConfigurations
Twilio · object[]
These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.
Show child attributes
observabilityPlan
Langfuse · object
This is the plan for observability of assistant's calls.
These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.
This is a set of actions that will be performed on certain events.
AssistantHookCallEnding
AssistantHookAssistantSpeechInterrupted
AssistantHookCustomerSpeechInterrupted
Show child attributes
name
string
This is the name of the assistant.
This is required when you want to transfer between assistants in a call.
Maximum string length: 40
voicemailMessage
string
This is the message that the assistant will say if the call is forwarded to voicemail.
If unspecified, it will hang up.
Maximum string length: 1000
endCallMessage
string
This is the message that the assistant will say if it ends the call.
If unspecified, it will hang up without saying anything.
Maximum string length: 1000
endCallPhrases
string[]
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
Required string length: 2 - 140
compliancePlan
object
Show child attributes
metadata
object
This is for metadata you want to store on the assistant.
backgroundSpeechDenoisingPlan
object
This enables filtering of noise and background speech while the user is talking.
Features:
Smart denoising using Krisp
Fourier denoising
Smart denoising can be combined with or used independently of Fourier denoising.
Order of precedence:
Smart denoising
Fourier denoising
Show child attributes
analysisPlan
object
This is the plan for analysis of assistant's calls. Stored in call.analysis.
Show child attributes
artifactPlan
object
This is the plan for artifacts generated during assistant's calls. Stored in call.artifact.
Show child attributes
messagePlan
object
This is the plan for static predefined messages that can be spoken by the assistant during the call, like idleMessages.
Note: firstMessage, voicemailMessage, and endCallMessage are currently at the root level. They will be moved to messagePlan in the future, but will remain backwards compatible.
Show child attributes
startSpeakingPlan
object
This is the plan for when the assistant should start talking.
You should configure this if you're running into these issues:
The assistant is too slow to start talking after the customer is done speaking.
The assistant is too fast to start talking after the customer is done speaking.
The assistant is so fast that it's actually interrupting the customer.
Show child attributes
stopSpeakingPlan
object
This is the plan for when assistant should stop talking on customer interruption.
You should configure this if you're running into these issues:
The assistant is too slow to recognize customer's interruption.
The assistant is too fast to recognize customer's interruption.
The assistant is getting interrupted by phrases that are just acknowledgments.
The assistant is getting interrupted by background noises.
The assistant is not properly stopping -- it starts talking right after getting interrupted.
Show child attributes
monitorPlan
object
This is the plan for real-time monitoring of the assistant's calls.
Usage:
To enable live listening of the assistant's calls, set monitorPlan.listenEnabled to true.
To enable live control of the assistant's calls, set monitorPlan.controlEnabled to true.
Show child attributes
credentialIds
string[]
These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.
server
object
This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
The order of precedence is:
assistant.server.url
phoneNumber.serverUrl
org.serverUrl
Show child attributes
keypadInputPlan
object
Show child attributes
Response
200 - application/json
id
string
required
This is the unique identifier for the assistant.
orgId
string
required
This is the unique identifier for the org that this assistant belongs to.
createdAt
string<date-time>
required
This is the ISO 8601 date-time string of when the assistant was created.
updatedAt
string<date-time>
required
This is the ISO 8601 date-time string of when the assistant was last updated.
transcriber
AssemblyAITranscriber · object
These are the options for the assistant's transcriber.
AssemblyAITranscriber
AzureSpeechTranscriber
CustomTranscriber
DeepgramTranscriber
ElevenLabsTranscriber
GladiaTranscriber
GoogleTranscriber
SpeechmaticsTranscriber
TalkscriberTranscriber
OpenAITranscriber
CartesiaTranscriber
Show child attributes
model
Anthropic · object
These are the options for the assistant's LLM.
Anthropic
Anyscale
Cerebras
CustomLLM
DeepInfra
DeepSeek
Google
Groq
InflectionAI
OpenAI
OpenRouter
PerplexityAI
Together
XAI
Show child attributes
voice
AzureVoice · object
These are the options for the assistant's voice.
AzureVoice
CartesiaVoice
CustomVoice
DeepgramVoice
ElevenLabsVoice
HumeVoice
LMNTVoice
NeuphonicVoice
OpenAIVoice
PlayHTVoice
RimeAIVoice
SmallestAIVoice
TavusVoice
cozmoxVoice
SesameVoice
InworldVoice
Show child attributes
firstMessage
string
This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
Example:
"Hello! How can I help you today?"
firstMessageInterruptionsEnabled
boolean
default:false
firstMessageMode
enum<string>
This is the mode for the first message. Default is 'assistant-speaks-first'.
Use:
'assistant-speaks-first' to have the assistant speak first.
'assistant-waits-for-user' to have the assistant wait for the user to speak first.
'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (assistant.model.messages at call start, call.messages at squad transfer points).
These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].
This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.
You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.
Google
OpenAI
Twilio
cozmox
Show child attributes
clientMessages
enum<string>[]
These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.
These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.
How many seconds of silence to wait before ending the call. Defaults to 30.
@default 30
Required range: 10 <= x <= 3600
Example:
30
maxDurationSeconds
number
This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
@default 600 (10 minutes)
Required range: 10 <= x <= 43200
Example:
600
backgroundSound
enum<string>string<uri>
This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
You can also provide a custom sound by providing a URL to an audio file.
Available options:
off,
office
Example:
"office"
backgroundDenoisingEnabled
boolean
deprecated
This enables filtering of noise and background speech while the user is talking.
Default false while in beta.
@default false
Example:
false
modelOutputInMessagesEnabled
boolean
This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
Default false while in beta.
@default false
Example:
false
transportConfigurations
Twilio · object[]
These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.
Show child attributes
observabilityPlan
Langfuse · object
This is the plan for observability of assistant's calls.
These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.
This is a set of actions that will be performed on certain events.
AssistantHookCallEnding
AssistantHookAssistantSpeechInterrupted
AssistantHookCustomerSpeechInterrupted
Show child attributes
name
string
This is the name of the assistant.
This is required when you want to transfer between assistants in a call.
Maximum string length: 40
voicemailMessage
string
This is the message that the assistant will say if the call is forwarded to voicemail.
If unspecified, it will hang up.
Maximum string length: 1000
endCallMessage
string
This is the message that the assistant will say if it ends the call.
If unspecified, it will hang up without saying anything.
Maximum string length: 1000
endCallPhrases
string[]
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
Required string length: 2 - 140
compliancePlan
object
Show child attributes
metadata
object
This is for metadata you want to store on the assistant.
backgroundSpeechDenoisingPlan
object
This enables filtering of noise and background speech while the user is talking.
Features:
Smart denoising using Krisp
Fourier denoising
Smart denoising can be combined with or used independently of Fourier denoising.
Order of precedence:
Smart denoising
Fourier denoising
Show child attributes
analysisPlan
object
This is the plan for analysis of assistant's calls. Stored in call.analysis.
Show child attributes
artifactPlan
object
This is the plan for artifacts generated during assistant's calls. Stored in call.artifact.
Show child attributes
messagePlan
object
This is the plan for static predefined messages that can be spoken by the assistant during the call, like idleMessages.
Note: firstMessage, voicemailMessage, and endCallMessage are currently at the root level. They will be moved to messagePlan in the future, but will remain backwards compatible.
Show child attributes
startSpeakingPlan
object
This is the plan for when the assistant should start talking.
You should configure this if you're running into these issues:
The assistant is too slow to start talking after the customer is done speaking.
The assistant is too fast to start talking after the customer is done speaking.
The assistant is so fast that it's actually interrupting the customer.
Show child attributes
stopSpeakingPlan
object
This is the plan for when assistant should stop talking on customer interruption.
You should configure this if you're running into these issues:
The assistant is too slow to recognize customer's interruption.
The assistant is too fast to recognize customer's interruption.
The assistant is getting interrupted by phrases that are just acknowledgments.
The assistant is getting interrupted by background noises.
The assistant is not properly stopping -- it starts talking right after getting interrupted.
Show child attributes
monitorPlan
object
This is the plan for real-time monitoring of the assistant's calls.
Usage:
To enable live listening of the assistant's calls, set monitorPlan.listenEnabled to true.
To enable live control of the assistant's calls, set monitorPlan.controlEnabled to true.
Show child attributes
credentialIds
string[]
These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.
server
object
This is where cozmox will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
The order of precedence is:
assistant.server.url
phoneNumber.serverUrl
org.serverUrl
Show child attributes
keypadInputPlan
object
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Cozmox-AI Nebula SDK","colors":{"primary":"#FF5911","light":"#FF5911","dark":"#c44b09"},"favicon":"/logo/favicon.png","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_dark.svg"},"navbar":{"links":[{"label":"Support","href":"mailto:development@cozmox.ai"}],"primary":{"type":"button","label":"Dashboard","href":"https://cozmox.ai"}},"footer":{"socials":{"x":"https://x.com/cozmoxai","linkedin":"https://www.linkedin.com/company/cozmox-ai/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"czmx","hasAudioNarration":false,"actualSubdomain":"czmx","customDomains":["docs.cozmox.cloud"],"gitSource":{"type":"github","owner":"zywa-co","repo":"sdk-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9248dc5f2fcf249014baf:success","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":120},{"language":"default","tag":"Assistants","count":5},{"language":"default","tag":"Calls","count":5},{"language":"default","tag":"Campaigns","count":5},{"language":"default","tag":"Chats","count":5},{"language":"default","tag":"Files","count":5},{"language":"default","tag":"Knowledge Base","count":5},{"language":"default","tag":"Phone Numbers","count":5},{"language":"default","tag":"Sessions","count":5},{"language":"default","tag":"Tools","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/assistants/update-assistant","slug":"/api-reference/assistants/update-assistant","pageMetadata":{"openapi":"patch /assistant/{id}","title":"Update Assistant","description":null,"href":"/api-reference/assistants/update-assistant"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /assistant/{id}","title":"Update Assistant","description":null,"href":"/api-reference/assistants/update-assistant"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"AssistantController_update","summary":"Update Assistant","parameters":["077e4cd0-b59e-442b-8162-3f8d2052db38"],"requestBody":"bfa48bd1-6c63-48aa-aba0-f31565c1f3e8","responses":{"200":"8786ce45-0da5-41f6-b2ee-1f6daa2fed23"},"tags":["Assistants"],"security":["d6171748-568c-4bc0-9b92-26bc98ea3bd8"],"method":"patch","type":"path","servers":["b5b8326a-680d-4e65-bd4d-46e31c9c1334","1698761f-fe56-43c1-839e-05ab7d829049"],"path":"/assistant/{id}","baseUrlOptions":["https://api.cozmox.ai","https://api.cozmox.ai"],"title":"Update Assistant","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"077e4cd0-b59e-442b-8162-3f8d2052db38":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"transcriber":{"oneOf":[{"type":"object","title":"AssemblyAITranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.0.disablePartialTranscripts","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.0.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.0.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.0","typeLabel":"AssemblyAITranscriber · object"},{"type":"object","title":"AzureSpeechTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.1.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.1.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.1.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.1","typeLabel":"AzureSpeechTranscriber · object"},{"type":"object","title":"CustomTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.2.server","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.2.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.2.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.2","typeLabel":"CustomTranscriber · object"},{"type":"object","title":"DeepgramTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.3.endpointing","typeLabel":"number"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.3.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.3.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.3","typeLabel":"DeepgramTranscriber · object"},{"type":"object","title":"ElevenLabsTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.4.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.4.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.4.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.4","typeLabel":"ElevenLabsTranscriber · object"},{"type":"object","title":"GladiaTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.5.confidenceThreshold","typeLabel":"number"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.5.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.5.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.5","typeLabel":"GladiaTranscriber · object"},{"type":"object","title":"GoogleTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.6.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.6.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.6.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.6","typeLabel":"GoogleTranscriber · object"},{"type":"object","title":"SpeechmaticsTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.7.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.7.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.7.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.7","typeLabel":"SpeechmaticsTranscriber · object"},{"type":"object","title":"TalkscriberTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.8.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.8.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.8.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.8","typeLabel":"TalkscriberTranscriber · object"},{"type":"object","title":"OpenAITranscriber","description":"These are the options for the assistant's transcriber.","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.9.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.9.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.9.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.9","typeLabel":"OpenAITranscriber · object"},{"type":"object","title":"CartesiaTranscriber","description":"These are the options for the assistant's transcriber.","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.10.language","typeLabel":"enum\u003cstring>"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["transcribers"],"properties":{"transcribers":{"type":"array","items":{"oneOf":[{"type":"object","title":"AssemblyAI","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["assembly-ai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["en"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.language","typeLabel":"enum\u003cstring>"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.confidenceThreshold","typeLabel":"number"},"enableUniversalStreamingApi":{"type":"boolean","description":"Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.enableUniversalStreamingApi","typeLabel":"boolean"},"formatTurns":{"type":"boolean","description":"This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.formatTurns","typeLabel":"boolean"},"endOfTurnConfidenceThreshold":{"type":"number","description":"The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7","minimum":0,"maximum":1,"example":0.7,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endOfTurnConfidenceThreshold","typeLabel":"number"},"minEndOfTurnSilenceWhenConfident":{"type":"number","description":"The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.minEndOfTurnSilenceWhenConfident","typeLabel":"number"},"wordFinalizationMaxWaitTime":{"type":"number","description":"The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160","minimum":0,"example":160,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordFinalizationMaxWaitTime","typeLabel":"number"},"maxTurnSilence":{"type":"number","description":"The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400","minimum":0,"example":400,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.maxTurnSilence","typeLabel":"number"},"realtimeUrl":{"type":"string","description":"The WebSocket URL that the transcriber connects to.","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.realtimeUrl","typeLabel":"string"},"wordBoost":{"description":"Add up to 2500 characters of custom vocabulary.","type":"array","items":{"type":"string","maxLength":2500,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.wordBoost","typeLabel":"string[]"},"endUtteranceSilenceThreshold":{"type":"number","description":"The duration of the end utterance silence threshold in milliseconds.","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.endUtteranceSilenceThreshold","typeLabel":"number"},"disablePartialTranscripts":{"type":"boolean","description":"Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`.","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0.disablePartialTranscripts","typeLabel":"boolean"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.0","typeLabel":"AssemblyAI · object"},{"type":"object","title":"Azure","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt","enum":["af-ZA","am-ET","ar-AE","ar-BH","ar-DZ","ar-EG","ar-IL","ar-IQ","ar-JO","ar-KW","ar-LB","ar-LY","ar-MA","ar-OM","ar-PS","ar-QA","ar-SA","ar-SY","ar-TN","ar-YE","az-AZ","bg-BG","bn-IN","bs-BA","ca-ES","cs-CZ","cy-GB","da-DK","de-AT","de-CH","de-DE","el-GR","en-AU","en-CA","en-GB","en-GH","en-HK","en-IE","en-IN","en-KE","en-NG","en-NZ","en-PH","en-SG","en-TZ","en-US","en-ZA","es-AR","es-BO","es-CL","es-CO","es-CR","es-CU","es-DO","es-EC","es-ES","es-GQ","es-GT","es-HN","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et-EE","eu-ES","fa-IR","fi-FI","fil-PH","fr-BE","fr-CA","fr-CH","fr-FR","ga-IE","gl-ES","gu-IN","he-IL","hi-IN","hr-HR","hu-HU","hy-AM","id-ID","is-IS","it-CH","it-IT","ja-JP","jv-ID","ka-GE","kk-KZ","km-KH","kn-IN","ko-KR","lo-LA","lt-LT","lv-LV","mk-MK","ml-IN","mn-MN","mr-IN","ms-MY","mt-MT","my-MM","nb-NO","ne-NP","nl-BE","nl-NL","pa-IN","pl-PL","ps-AF","pt-BR","pt-PT","ro-RO","ru-RU","si-LK","sk-SK","sl-SI","so-SO","sq-AL","sr-RS","sv-SE","sw-KE","sw-TZ","ta-IN","te-IN","th-TH","tr-TR","uk-UA","ur-IN","uz-UZ","vi-VN","wuu-CN","yue-CN","zh-CN","zh-CN-shandong","zh-CN-sichuan","zh-HK","zh-TW","zu-ZA"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.1","typeLabel":"Azure · object"},{"type":"object","title":"Custom","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.","enum":["custom-transcriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the transcription request will be sent.\n\nUsage:\n1. cozmox will initiate a websocket connection with `server.url`.\n\n2. cozmox will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. cozmox will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2.server","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.2","typeLabel":"Custom · object"},{"type":"object","title":"Deepgram","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-phonecall","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","base-general","base-meeting","base-phonecall","base-finance","base-conversationalai","base-voicemail","base-video","whisper"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model.oneOf.1","typeLabel":"string"}],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.model","typeLabel":"enum\u003cstring> | string"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview","enum":["ar","az","ba","bg","br","ca","cs","da","da-DK","de","de-CH","el","en","en-AU","en-GB","en-IN","en-NZ","en-US","es","es-419","es-LATAM","et","eu","fi","fr","fr-CA","ha","haw","he","hi","hi-Latn","hu","id","is","it","ja","jw","kn","ko","ko-KR","ln","lt","lv","mk","ms","multi","nl","nl-BE","no","pl","pt","pt-BR","ro","ru","sk","sl","sn","so","sr","su","sv","sv-SE","ta","taq","th","th-TH","tr","tt","uk","ur","vi","yo","zh","zh-CN","zh-HK","zh-Hans","zh-Hant","zh-TW"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.language","typeLabel":"enum\u003cstring>"},"smartFormat":{"type":"boolean","description":"This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.smartFormat","typeLabel":"boolean"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.mipOptOut","typeLabel":"boolean"},"numerals":{"type":"boolean","description":"If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.numerals","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.confidenceThreshold","typeLabel":"number"},"keywords":{"description":"These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.","type":"array","items":{"type":"string","pattern":"/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keywords","typeLabel":"string[]"},"keyterm":{"description":"Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.","type":"array","items":{"type":"string","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm.items.[INDEX]","typeLabel":"string"},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.keyterm","typeLabel":"string[]"},"endpointing":{"type":"number","description":"This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@cozmox.ai and we'll find another solution.\n\n@default 10","minimum":10,"maximum":500,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3.endpointing","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.3","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["scribe_v1"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.4.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.4","typeLabel":"ElevenLabs · object"},{"type":"object","title":"Gladia","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["gladia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the Gladia model that will be used. Default is 'fast'","enum":["fast","accurate","solaria-1"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"languageBehaviour":{"type":"string","description":"Defines how the transcription model detects the audio language. Default value is 'automatic single language'.","enum":["manual","automatic single language","automatic multiple languages"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languageBehaviour","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.language","typeLabel":"enum\u003cstring>"},"languages":{"type":"string","description":"Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.","enum":["af","sq","am","ar","hy","as","az","ba","eu","be","bn","bs","br","bg","ca","zh","hr","cs","da","nl","en","et","fo","fi","fr","gl","ka","de","el","gu","ht","ha","haw","he","hi","hu","is","id","it","ja","jv","kn","kk","km","ko","lo","la","lv","ln","lt","lb","mk","mg","ms","ml","mt","mi","mr","mn","my","ne","no","nn","oc","ps","fa","pl","pt","pa","ro","ru","sa","sr","sn","sd","si","sk","sl","so","es","su","sw","sv","tl","tg","ta","tt","te","th","bo","tr","tk","uk","ur","uz","vi","cy","yi","yo"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.languages","typeLabel":"enum\u003cstring>"},"transcriptionHint":{"type":"string","description":"Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.","maxLength":600,"example":"custom vocabulary","uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.transcriptionHint","typeLabel":"string"},"prosody":{"type":"boolean","description":"If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.prosody","typeLabel":"boolean"},"audioEnhancer":{"type":"boolean","description":"If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.","example":false,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.audioEnhancer","typeLabel":"boolean"},"confidenceThreshold":{"type":"number","description":"Transcripts below this confidence threshold will be discarded.\n\n@default 0.4","minimum":0,"maximum":1,"example":0.4,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5.confidenceThreshold","typeLabel":"number"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.5","typeLabel":"Gladia · object"},{"type":"object","title":"Google","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["google"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.6.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["Multilingual","Arabic","Bengali","Bulgarian","Chinese","Croatian","Czech","Danish","Dutch","English","Estonian","Finnish","French","German","Greek","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Latvian","Lithuanian","Norwegian","Polish","Portuguese","Romanian","Russian","Serbian","Slovak","Slovenian","Spanish","Swahili","Swedish","Thai","Turkish","Ukrainian","Vietnamese"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.6.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Talkscriber","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["talkscriber"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["whisper"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.7.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py","enum":["en","zh","de","es","ru","ko","fr","ja","pt","tr","pl","ca","nl","ar","sv","it","id","hi","fi","vi","he","uk","el","ms","cs","ro","da","hu","ta","no","th","ur","hr","bg","lt","la","mi","ml","cy","sk","te","fa","lv","bn","sr","az","sl","kn","et","mk","br","eu","is","hy","ne","mn","bs","kk","sq","sw","gl","mr","pa","si","km","sn","yo","so","af","oc","ka","be","tg","sd","gu","am","yi","lo","uz","fo","ht","ps","tk","nn","mt","sa","lb","my","bo","tl","mg","as","tt","haw","ln","ha","ba","jw","su","yue"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.7","typeLabel":"Talkscriber · object"},{"type":"object","title":"Speechmatics","required":["provider"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["speechmatics"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["default"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["auto","ar","ba","eu","be","bn","bg","yue","ca","hr","cs","da","nl","en","eo","et","fi","fr","gl","de","el","he","hi","hu","id","ia","ga","it","ja","ko","lv","lt","ms","mt","cmn","mr","mn","no","fa","pl","pt","ro","ru","sk","sl","es","sw","sv","ta","th","tr","uk","ur","ug","vi","cy"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.8.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.8","typeLabel":"Speechmatics · object"},{"type":"object","title":"OpenAI","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the transcription provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the model that will be used for the transcription.","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be set for the transcription.","enum":["af","ar","hy","az","be","bs","bg","ca","zh","hr","cs","da","nl","en","et","fi","fr","gl","de","el","he","hi","hu","is","id","it","ja","kn","kk","ko","lv","lt","mk","ms","mr","mi","ne","no","fa","pl","pt","ro","ru","sr","sk","sl","es","sw","sv","tl","ta","th","tr","uk","ur","vi","cy"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"Cartesia","required":["provider"],"properties":{"provider":{"type":"string","enum":["cartesia"],"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["ink-whisper"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.10.language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX].oneOf.10","typeLabel":"Cartesia · object"}],"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers.items.[INDEX]","typeLabel":"AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object"},"isRequired":true,"uniqueKey":"transcriber.oneOf.10.fallbackPlan.transcribers","typeLabel":"(AssemblyAI · object | Azure · object | Custom · object | Deepgram · object | ElevenLabs · object | Gladia · object | Google · object | Talkscriber · object | Speechmatics · object | OpenAI · object | Cartesia · object)[]"}},"uniqueKey":"transcriber.oneOf.10.fallbackPlan","typeLabel":"object"}},"uniqueKey":"transcriber.oneOf.10","typeLabel":"CartesiaTranscriber · object"}],"uniqueKey":"transcriber","typeLabel":"AssemblyAITranscriber · object | AzureSpeechTranscriber · object | CustomTranscriber · object | DeepgramTranscriber · object | ElevenLabsTranscriber · object | GladiaTranscriber · object | GoogleTranscriber · object | SpeechmaticsTranscriber · object | TalkscriberTranscriber · object | OpenAITranscriber · object | CartesiaTranscriber · object"},"model":{"oneOf":[{"type":"object","title":"Anthropic","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"The specific Anthropic/Claude model that will be used.","enum":["claude-3-opus-20240229","claude-3-sonnet-20240229","claude-3-haiku-20240307","claude-3-5-sonnet-20240620","claude-3-5-sonnet-20241022","claude-3-5-haiku-20241022","claude-3-7-sonnet-20250219","claude-opus-4-20250514","claude-sonnet-4-20250514"],"isRequired":true,"uniqueKey":"model.oneOf.0.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"The provider identifier for Anthropic.","enum":["anthropic"],"isRequired":true,"uniqueKey":"model.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.0.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.0.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.0.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.0.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.0.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.0.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.0.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.0.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.0.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.0.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.0.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.0.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.0.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.0.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.0.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.0.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.0.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.0.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.0.knowledgeBaseId","typeLabel":"string"},"thinking":{"type":"object","description":"Optional configuration for Anthropic's thinking feature.\nOnly applicable for claude-3-7-sonnet-20250219 model.\nIf provided, maxTokens must be greater than thinking.budgetTokens.","required":["type","budgetTokens"],"properties":{"type":{"type":"string","enum":["enabled"],"isRequired":true,"uniqueKey":"model.oneOf.0.thinking.type","typeLabel":"enum\u003cstring>"},"budgetTokens":{"type":"number","description":"The maximum number of tokens to allocate for thinking.\nMust be between 1024 and 100000 tokens.","minimum":1024,"maximum":100000,"isRequired":true,"uniqueKey":"model.oneOf.0.thinking.budgetTokens","typeLabel":"number"}},"uniqueKey":"model.oneOf.0.thinking","typeLabel":"object"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.0.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.0.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.0.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.0.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.0","typeLabel":"Anthropic · object"},{"type":"object","title":"Anyscale","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","enum":["anyscale"],"isRequired":true,"uniqueKey":"model.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.1.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.1.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.1.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.1.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.1.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.1.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.1.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.1.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.1.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.1.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.1.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.1.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.1.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.1.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.1.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.1.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.1.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.1.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.1.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.1.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.1.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.1.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.1.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.1.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.1.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.1","typeLabel":"Anyscale · object"},{"type":"object","title":"Cerebras","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","enum":["llama3.1-8b","llama-3.3-70b"],"isRequired":true,"uniqueKey":"model.oneOf.2.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["cerebras"],"isRequired":true,"uniqueKey":"model.oneOf.2.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.2.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.2.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.2.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.2.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.2.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.2.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.2.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.2.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.2.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.2.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.2.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.2.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.2.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.2.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.2.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.2.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.2.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.2.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.2.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.2.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.2.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.2.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.2.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.2.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.2","typeLabel":"Cerebras · object"},{"type":"object","title":"CustomLLM","description":"These are the options for the assistant's LLM.","required":["provider","url","model"],"properties":{"provider":{"type":"string","description":"This is the provider that will be used for the model. Any service, including your own server, that is compatible with the OpenAI API can be used.","enum":["custom-llm"],"isRequired":true,"uniqueKey":"model.oneOf.3.provider","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1","isRequired":true,"uniqueKey":"model.oneOf.3.url","typeLabel":"string"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.3.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.3.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.3.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.3.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.3.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.3.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.3.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.3.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.3.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.3.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.3.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.3.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.3.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.3.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.3.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.3.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.3.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.3.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.3.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.3.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.3.knowledgeBaseId","typeLabel":"string"},"metadataSendMode":{"type":"string","description":"This determines whether metadata is sent in requests to the custom provider.\n\n- `off` will not send any metadata. payload will look like `{ messages }`\n- `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }`\n- `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }`\n\nFurther, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload.\n\nDefault is `variable`.","enum":["off","variable","destructured"],"uniqueKey":"model.oneOf.3.metadataSendMode","typeLabel":"enum\u003cstring>"},"timeoutSeconds":{"type":"number","description":"This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.","minimum":20,"maximum":600,"uniqueKey":"model.oneOf.3.timeoutSeconds","typeLabel":"number"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.3.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.3.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.3.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.3.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.3","typeLabel":"CustomLLM · object"},{"type":"object","title":"DeepInfra","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","enum":["deepinfra"],"isRequired":true,"uniqueKey":"model.oneOf.4.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.4.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.4.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.4.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.4.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.4.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.4.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.4.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.4.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.4.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.4.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.4.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.4.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.4.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.4.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.4.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.4.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.4.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.4.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.4.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.4.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.4.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.4.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.4.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.4.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.4.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.4","typeLabel":"DeepInfra · object"},{"type":"object","title":"DeepSeek","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","enum":["deepseek-chat","deepseek-reasoner"],"isRequired":true,"uniqueKey":"model.oneOf.5.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["deep-seek"],"isRequired":true,"uniqueKey":"model.oneOf.5.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.5.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.5.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.5.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.5.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.5.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.5.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.5.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.5.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.5.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.5.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.5.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.5.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.5.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.5.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.5.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.5.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.5.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.5.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.5.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.5.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.5.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.5.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.5.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.5.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.5","typeLabel":"DeepSeek · object"},{"type":"object","title":"Google","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the Google model that will be used.","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"isRequired":true,"uniqueKey":"model.oneOf.6.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["google"],"isRequired":true,"uniqueKey":"model.oneOf.6.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.6.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.6.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.6.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.6.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.6.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.6.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.6.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.6.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.6.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.6.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.6.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.6.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.6.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.6.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.6.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.6.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.6.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.6.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.6.knowledgeBaseId","typeLabel":"string"},"realtimeConfig":{"type":"object","description":"This is the session configuration for the Gemini Flash 2.0 Multimodal Live API.\nOnly applicable if the model `gemini-2.0-flash-realtime-exp` is selected.","properties":{"topP":{"type":"number","description":"This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.","uniqueKey":"model.oneOf.6.realtimeConfig.topP","typeLabel":"number"},"topK":{"type":"number","description":"This is the top-k sampling parameter that limits the number of highest probability tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.","uniqueKey":"model.oneOf.6.realtimeConfig.topK","typeLabel":"number"},"presencePenalty":{"type":"number","description":"This is the presence penalty parameter that influences the model's likelihood to repeat information by penalizing tokens based on their presence in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.","uniqueKey":"model.oneOf.6.realtimeConfig.presencePenalty","typeLabel":"number"},"frequencyPenalty":{"type":"number","description":"This is the frequency penalty parameter that influences the model's likelihood to repeat tokens by penalizing them based on their frequency in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.","uniqueKey":"model.oneOf.6.realtimeConfig.frequencyPenalty","typeLabel":"number"},"speechConfig":{"type":"object","description":"This is the speech configuration object that defines the voice settings to be used for the model's speech output.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.","required":["voiceConfig"],"properties":{"voiceConfig":{"type":"object","properties":{"prebuiltVoiceConfig":{"type":"object","properties":{"voiceName":{"type":"string","enum":["Puck","Charon","Kore","Fenrir","Aoede"],"isRequired":true,"uniqueKey":"model.oneOf.6.realtimeConfig.speechConfig.voiceConfig.prebuiltVoiceConfig.voiceName","typeLabel":"enum\u003cstring>"}},"required":["voiceName"],"isRequired":true,"uniqueKey":"model.oneOf.6.realtimeConfig.speechConfig.voiceConfig.prebuiltVoiceConfig","typeLabel":"object"}},"required":["prebuiltVoiceConfig"],"isRequired":true,"uniqueKey":"model.oneOf.6.realtimeConfig.speechConfig.voiceConfig","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.realtimeConfig.speechConfig","typeLabel":"object"}},"uniqueKey":"model.oneOf.6.realtimeConfig","typeLabel":"object"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.6.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.6.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.6.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.6.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.6","typeLabel":"Google · object"},{"type":"object","title":"Groq","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","enum":["deepseek-r1-distill-llama-70b","llama-3.3-70b-versatile","llama-3.1-405b-reasoning","llama-3.1-8b-instant","llama3-8b-8192","llama3-70b-8192","gemma2-9b-it","meta-llama/llama-4-maverick-17b-128e-instruct","meta-llama/llama-4-scout-17b-16e-instruct","mistral-saba-24b","compound-beta","compound-beta-mini"],"isRequired":true,"uniqueKey":"model.oneOf.7.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["groq"],"isRequired":true,"uniqueKey":"model.oneOf.7.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.7.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.7.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.7.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.7.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.7.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.7.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.7.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.7.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.7.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.7.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.7.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.7.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.7.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.7.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.7.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.7.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.7.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.7.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.7.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.7.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.7.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.7.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.7.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.7.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.7","typeLabel":"Groq · object"},{"type":"object","title":"InflectionAI","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","enum":["inflection_3_pi"],"isRequired":true,"uniqueKey":"model.oneOf.8.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["inflection-ai"],"isRequired":true,"uniqueKey":"model.oneOf.8.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.8.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.8.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.8.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.8.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.8.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.8.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.8.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.8.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.8.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.8.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.8.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.8.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.8.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.8.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.8.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.8.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.8.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.8.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.8.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.8.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.8.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.8.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.8.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.8.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.8","typeLabel":"InflectionAI · object"},{"type":"object","title":"OpenAI","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","description":"This is the provider that will be used for the model.","enum":["openai"],"isRequired":true,"uniqueKey":"model.oneOf.9.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the OpenAI model that will be used.\n\nWhen using cozmox OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. cozmox will automatically find the fastest region that make sense.\nThis is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.\n\n@default undefined","enum":["gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.5-preview","chatgpt-4o-latest","o3","o3-mini","o4-mini","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-mini-realtime-preview-2024-12-17","gpt-4o-mini-2024-07-18","gpt-4o-mini","gpt-4o","gpt-4o-2024-05-13","gpt-4o-2024-08-06","gpt-4o-2024-11-20","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-turbo-preview","gpt-4-0125-preview","gpt-4-1106-preview","gpt-4","gpt-4-0613","gpt-3.5-turbo","gpt-3.5-turbo-0125","gpt-3.5-turbo-1106","gpt-3.5-turbo-16k","gpt-3.5-turbo-0613","gpt-4.1-2025-04-14:westus","gpt-4.1-2025-04-14:eastus2","gpt-4.1-2025-04-14:eastus","gpt-4.1-2025-04-14:westus3","gpt-4.1-2025-04-14:northcentralus","gpt-4.1-2025-04-14:southcentralus","gpt-4.1-mini-2025-04-14:westus","gpt-4.1-mini-2025-04-14:eastus2","gpt-4.1-mini-2025-04-14:eastus","gpt-4.1-mini-2025-04-14:westus3","gpt-4.1-mini-2025-04-14:northcentralus","gpt-4.1-mini-2025-04-14:southcentralus","gpt-4.1-nano-2025-04-14:westus","gpt-4.1-nano-2025-04-14:eastus2","gpt-4.1-nano-2025-04-14:westus3","gpt-4.1-nano-2025-04-14:northcentralus","gpt-4.1-nano-2025-04-14:southcentralus","gpt-4o-2024-11-20:swedencentral","gpt-4o-2024-11-20:westus","gpt-4o-2024-11-20:eastus2","gpt-4o-2024-11-20:eastus","gpt-4o-2024-11-20:westus3","gpt-4o-2024-11-20:southcentralus","gpt-4o-2024-08-06:westus","gpt-4o-2024-08-06:westus3","gpt-4o-2024-08-06:eastus","gpt-4o-2024-08-06:eastus2","gpt-4o-2024-08-06:northcentralus","gpt-4o-2024-08-06:southcentralus","gpt-4o-mini-2024-07-18:westus","gpt-4o-mini-2024-07-18:westus3","gpt-4o-mini-2024-07-18:eastus","gpt-4o-mini-2024-07-18:eastus2","gpt-4o-mini-2024-07-18:northcentralus","gpt-4o-mini-2024-07-18:southcentralus","gpt-4o-2024-05-13:eastus2","gpt-4o-2024-05-13:eastus","gpt-4o-2024-05-13:northcentralus","gpt-4o-2024-05-13:southcentralus","gpt-4o-2024-05-13:westus3","gpt-4o-2024-05-13:westus","gpt-4-turbo-2024-04-09:eastus2","gpt-4-0125-preview:eastus","gpt-4-0125-preview:northcentralus","gpt-4-0125-preview:southcentralus","gpt-4-1106-preview:australia","gpt-4-1106-preview:canadaeast","gpt-4-1106-preview:france","gpt-4-1106-preview:india","gpt-4-1106-preview:norway","gpt-4-1106-preview:swedencentral","gpt-4-1106-preview:uk","gpt-4-1106-preview:westus","gpt-4-1106-preview:westus3","gpt-4-0613:canadaeast","gpt-3.5-turbo-0125:canadaeast","gpt-3.5-turbo-0125:northcentralus","gpt-3.5-turbo-0125:southcentralus","gpt-3.5-turbo-1106:canadaeast","gpt-3.5-turbo-1106:westus"],"isRequired":true,"uniqueKey":"model.oneOf.9.model","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.9.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.9.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.9.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.9.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.9.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.9.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.9.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.9.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.9.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.9.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.9.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.9.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.9.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.9.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.9.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.9.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.9.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.9.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.9.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.9.knowledgeBaseId","typeLabel":"string"},"fallbackModels":{"type":"array","description":"These are the fallback models that will be used if the primary model fails. This shouldn't be specified unless you have a specific reason to do so. cozmox will automatically find the fastest fallbacks that make sense.","enum":["gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.5-preview","chatgpt-4o-latest","o3","o3-mini","o4-mini","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-mini-realtime-preview-2024-12-17","gpt-4o-mini-2024-07-18","gpt-4o-mini","gpt-4o","gpt-4o-2024-05-13","gpt-4o-2024-08-06","gpt-4o-2024-11-20","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-turbo-preview","gpt-4-0125-preview","gpt-4-1106-preview","gpt-4","gpt-4-0613","gpt-3.5-turbo","gpt-3.5-turbo-0125","gpt-3.5-turbo-1106","gpt-3.5-turbo-16k","gpt-3.5-turbo-0613","gpt-4.1-2025-04-14:westus","gpt-4.1-2025-04-14:eastus2","gpt-4.1-2025-04-14:eastus","gpt-4.1-2025-04-14:westus3","gpt-4.1-2025-04-14:northcentralus","gpt-4.1-2025-04-14:southcentralus","gpt-4.1-mini-2025-04-14:westus","gpt-4.1-mini-2025-04-14:eastus2","gpt-4.1-mini-2025-04-14:eastus","gpt-4.1-mini-2025-04-14:westus3","gpt-4.1-mini-2025-04-14:northcentralus","gpt-4.1-mini-2025-04-14:southcentralus","gpt-4.1-nano-2025-04-14:westus","gpt-4.1-nano-2025-04-14:eastus2","gpt-4.1-nano-2025-04-14:westus3","gpt-4.1-nano-2025-04-14:northcentralus","gpt-4.1-nano-2025-04-14:southcentralus","gpt-4o-2024-11-20:swedencentral","gpt-4o-2024-11-20:westus","gpt-4o-2024-11-20:eastus2","gpt-4o-2024-11-20:eastus","gpt-4o-2024-11-20:westus3","gpt-4o-2024-11-20:southcentralus","gpt-4o-2024-08-06:westus","gpt-4o-2024-08-06:westus3","gpt-4o-2024-08-06:eastus","gpt-4o-2024-08-06:eastus2","gpt-4o-2024-08-06:northcentralus","gpt-4o-2024-08-06:southcentralus","gpt-4o-mini-2024-07-18:westus","gpt-4o-mini-2024-07-18:westus3","gpt-4o-mini-2024-07-18:eastus","gpt-4o-mini-2024-07-18:eastus2","gpt-4o-mini-2024-07-18:northcentralus","gpt-4o-mini-2024-07-18:southcentralus","gpt-4o-2024-05-13:eastus2","gpt-4o-2024-05-13:eastus","gpt-4o-2024-05-13:northcentralus","gpt-4o-2024-05-13:southcentralus","gpt-4o-2024-05-13:westus3","gpt-4o-2024-05-13:westus","gpt-4-turbo-2024-04-09:eastus2","gpt-4-0125-preview:eastus","gpt-4-0125-preview:northcentralus","gpt-4-0125-preview:southcentralus","gpt-4-1106-preview:australia","gpt-4-1106-preview:canadaeast","gpt-4-1106-preview:france","gpt-4-1106-preview:india","gpt-4-1106-preview:norway","gpt-4-1106-preview:swedencentral","gpt-4-1106-preview:uk","gpt-4-1106-preview:westus","gpt-4-1106-preview:westus3","gpt-4-0613:canadaeast","gpt-3.5-turbo-0125:canadaeast","gpt-3.5-turbo-0125:northcentralus","gpt-3.5-turbo-0125:southcentralus","gpt-3.5-turbo-1106:canadaeast","gpt-3.5-turbo-1106:westus"],"example":["gpt-4-0125-preview","gpt-4-0613"],"items":{"type":"string","enum":["gpt-4.1-2025-04-14","gpt-4.1-mini-2025-04-14","gpt-4.1-nano-2025-04-14","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4.5-preview","chatgpt-4o-latest","o3","o3-mini","o4-mini","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o-realtime-preview-2024-10-01","gpt-4o-realtime-preview-2024-12-17","gpt-4o-mini-realtime-preview-2024-12-17","gpt-4o-mini-2024-07-18","gpt-4o-mini","gpt-4o","gpt-4o-2024-05-13","gpt-4o-2024-08-06","gpt-4o-2024-11-20","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-turbo-preview","gpt-4-0125-preview","gpt-4-1106-preview","gpt-4","gpt-4-0613","gpt-3.5-turbo","gpt-3.5-turbo-0125","gpt-3.5-turbo-1106","gpt-3.5-turbo-16k","gpt-3.5-turbo-0613","gpt-4.1-2025-04-14:westus","gpt-4.1-2025-04-14:eastus2","gpt-4.1-2025-04-14:eastus","gpt-4.1-2025-04-14:westus3","gpt-4.1-2025-04-14:northcentralus","gpt-4.1-2025-04-14:southcentralus","gpt-4.1-mini-2025-04-14:westus","gpt-4.1-mini-2025-04-14:eastus2","gpt-4.1-mini-2025-04-14:eastus","gpt-4.1-mini-2025-04-14:westus3","gpt-4.1-mini-2025-04-14:northcentralus","gpt-4.1-mini-2025-04-14:southcentralus","gpt-4.1-nano-2025-04-14:westus","gpt-4.1-nano-2025-04-14:eastus2","gpt-4.1-nano-2025-04-14:westus3","gpt-4.1-nano-2025-04-14:northcentralus","gpt-4.1-nano-2025-04-14:southcentralus","gpt-4o-2024-11-20:swedencentral","gpt-4o-2024-11-20:westus","gpt-4o-2024-11-20:eastus2","gpt-4o-2024-11-20:eastus","gpt-4o-2024-11-20:westus3","gpt-4o-2024-11-20:southcentralus","gpt-4o-2024-08-06:westus","gpt-4o-2024-08-06:westus3","gpt-4o-2024-08-06:eastus","gpt-4o-2024-08-06:eastus2","gpt-4o-2024-08-06:northcentralus","gpt-4o-2024-08-06:southcentralus","gpt-4o-mini-2024-07-18:westus","gpt-4o-mini-2024-07-18:westus3","gpt-4o-mini-2024-07-18:eastus","gpt-4o-mini-2024-07-18:eastus2","gpt-4o-mini-2024-07-18:northcentralus","gpt-4o-mini-2024-07-18:southcentralus","gpt-4o-2024-05-13:eastus2","gpt-4o-2024-05-13:eastus","gpt-4o-2024-05-13:northcentralus","gpt-4o-2024-05-13:southcentralus","gpt-4o-2024-05-13:westus3","gpt-4o-2024-05-13:westus","gpt-4-turbo-2024-04-09:eastus2","gpt-4-0125-preview:eastus","gpt-4-0125-preview:northcentralus","gpt-4-0125-preview:southcentralus","gpt-4-1106-preview:australia","gpt-4-1106-preview:canadaeast","gpt-4-1106-preview:france","gpt-4-1106-preview:india","gpt-4-1106-preview:norway","gpt-4-1106-preview:swedencentral","gpt-4-1106-preview:uk","gpt-4-1106-preview:westus","gpt-4-1106-preview:westus3","gpt-4-0613:canadaeast","gpt-3.5-turbo-0125:canadaeast","gpt-3.5-turbo-0125:northcentralus","gpt-3.5-turbo-0125:southcentralus","gpt-3.5-turbo-1106:canadaeast","gpt-3.5-turbo-1106:westus"],"uniqueKey":"model.oneOf.9.fallbackModels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"model.oneOf.9.fallbackModels","typeLabel":"enum\u003cstring>[]"},"toolStrictCompatibilityMode":{"type":"string","description":"Azure OpenAI doesn't support `maxLength` right now https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/structured-outputs?tabs=python-secure%2Cdotnet-entra-id\u0026pivots=programming-language-csharp#unsupported-type-specific-keywords. Need to strip.\n\n- `strip-parameters-with-unsupported-validation` will strip parameters with unsupported validation.\n- `strip-unsupported-validation` will keep the parameters but strip unsupported validation.\n\n@default `strip-unsupported-validation`","enum":["strip-parameters-with-unsupported-validation","strip-unsupported-validation"],"uniqueKey":"model.oneOf.9.toolStrictCompatibilityMode","typeLabel":"enum\u003cstring>"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.9.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.9.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.9.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.9.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.9","typeLabel":"OpenAI · object"},{"type":"object","title":"OpenRouter","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","enum":["openrouter"],"isRequired":true,"uniqueKey":"model.oneOf.10.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.10.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.10.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.10.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.10.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.10.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.10.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.10.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.10.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.10.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.10.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.10.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.10.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.10.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.10.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.10.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.10.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.10.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.10.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.10.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.10.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.10.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.10.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.10.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.10.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.10.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.10","typeLabel":"OpenRouter · object"},{"type":"object","title":"PerplexityAI","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","enum":["perplexity-ai"],"isRequired":true,"uniqueKey":"model.oneOf.11.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.11.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.11.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.11.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.11.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.11.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.11.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.11.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.11.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.11.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.11.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.11.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.11.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.11.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.11.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.11.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.11.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.11.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.11.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.11.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.11.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.11.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.11.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.11.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.11.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.11.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.11","typeLabel":"PerplexityAI · object"},{"type":"object","title":"Together","description":"These are the options for the assistant's LLM.","required":["provider","model"],"properties":{"provider":{"type":"string","enum":["together-ai"],"isRequired":true,"uniqueKey":"model.oneOf.12.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","isRequired":true,"uniqueKey":"model.oneOf.12.model","typeLabel":"string"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.12.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.12.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.12.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.12.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.12.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.12.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.12.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.12.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.12.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.12.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.12.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.12.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.12.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.12.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.12.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.12.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.12.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.12.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.12.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.12.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.12.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.12.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.12.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.12.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.12","typeLabel":"Together · object"},{"type":"object","title":"XAI","description":"These are the options for the assistant's LLM.","required":["model","provider"],"properties":{"model":{"type":"string","description":"This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b","enum":["grok-beta","grok-2","grok-3"],"isRequired":true,"uniqueKey":"model.oneOf.13.model","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","enum":["xai"],"isRequired":true,"uniqueKey":"model.oneOf.13.provider","typeLabel":"enum\u003cstring>"},"messages":{"description":"This is the starting state for the conversation.","type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.13.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100000000,"isRequired":true,"uniqueKey":"model.oneOf.13.messages.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model.oneOf.13.messages.items.[INDEX].content","typeLabel":"string | null"},"role":{"type":"string","enum":["assistant","function","user","system","tool"],"isRequired":true,"uniqueKey":"model.oneOf.13.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["content","role"],"uniqueKey":"model.oneOf.13.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.messages","typeLabel":"object[]"},"tools":{"type":"array","description":"These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.","items":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.url","typeLabel":"string"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.timeoutSeconds","typeLabel":"number"},"name":{"type":"string","description":"This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.","maxLength":40,"pattern":"/^[a-zA-Z0-9_-]{1,40}$/","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"This is the description of the tool. This will be passed to the model.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"body":{"type":"object","description":"This is the body of the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.body","typeLabel":"object"},"headers":{"type":"object","description":"These are the headers to send in the request.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.backoffPlan","typeLabel":"object"},"variableExtractionPlan":{"type":"object","description":"This is the plan to extract variables from the tool's response. These will be accessible during the call and stored in `call.artifact.variableValues` after the call.\n\nUsage:\n1. Use `aliases` to extract variables from the tool's response body. (Most common case)\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{customer.name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{customer.age}}\"\n }\n ]\n}\n```\n\nThe tool response body is made available to the liquid template.\n\n2. Use `aliases` to extract variables from the tool's response body if the response is an array.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{$[0].name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{$[0].age}}\"\n }\n ]\n}\n```\n\n$ is a shorthand for the tool's response body. `$[0]` is the first item in the array. `$[n]` is the nth item in the array. Note, $ is available regardless of the response body type (both object and array).\n\n3. Use `aliases` to extract variables from the tool's response headers.\n\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{tool.response.headers.customer-name}}\"\n },\n {\n \"key\": \"customerAge\",\n \"value\": \"{{tool.response.headers.customer-age}}\"\n }\n ]\n}\n```\n\n`tool.response` is made available to the liquid template. Particularly, both `tool.response.headers` and `tool.response.body` are available. Note, `tool.response` is available regardless of the response body type (both object and array).\n\n4. Use `schema` to extract a large portion of the tool's response body.\n\n4.1. If you hit example.com and it returns `{\"name\": \"John\", \"age\": 30}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n }\n}\n```\n\n4.2. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n4.3. If you hit example.com and it returns `{\"name\": {\"first\": \"John\", \"last\": \"Doe\"}}`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n4.4. If you hit example.com and it returns `[\"94123\", \"94124\"]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4.5. If you hit example.com and it returns `[{\"name\": \"John\", \"age\": 30, \"zipCodes\": [\"94123\", \"94124\"]}, {\"name\": \"Jane\", \"age\": 25, \"zipCodes\": [\"94125\", \"94126\"]}]`, then you can specify the schema as:\n\n```json\n{\n \"schema\": {\n \"type\": \"array\",\n \"title\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.\n\nNote: Both `aliases` and `schema` can be used together.","properties":{"schema":{"type":"object","description":"This is the schema to extract.\n\nExamples:\n1. To extract object properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}` and `{{ age }}` respectively. To emphasize, object properties are extracted as direct global variables.\n\n2. To extract nested properties, you can use the following schema:\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": {\n \"type\": \"string\"\n },\n \"last\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThese will be extracted as `{{ name }}`. And, `{{ name.first }}` and `{{ name.last }}` will be accessible.\n\n3. To extract array items, you can use the following schema:\n```json\n{\n \"type\": \"array\",\n \"title\": \"zipCodes\",\n \"items\": {\n \"type\": \"string\"\n }\n}\n```\n\nThis will be extracted as `{{ zipCodes }}`. To access the array items, you can use `{{ zipCodes[0] }}` and `{{ zipCodes[1] }}`.\n\n4. To extract array of objects, you can use the following schema:\n\n```json\n{\n \"type\": \"array\",\n \"name\": \"people\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"number\"\n },\n \"zipCodes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ people }}`. To access the array items, you can use `{{ people[n].name }}`, `{{ people[n].age }}`, `{{ people[n].zipCodes }}`, `{{ people[n].zipCodes[0] }}` and `{{ people[n].zipCodes[1] }}`.","required":["type"],"properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.schema","typeLabel":"object"},"aliases":{"description":"These are additional variables to create.\n\nThese will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nExample:\n```json\n{\n \"aliases\": [\n {\n \"key\": \"customerName\",\n \"value\": \"{{name}}\"\n },\n {\n \"key\": \"fullName\",\n \"value\": \"{{firstName}} {{lastName}}\"\n },\n {\n \"key\": \"greeting\",\n \"value\": \"Hello {{name}}, welcome to {{company}}!\"\n },\n {\n \"key\": \"customerEmail\",\n \"value\": \"{{addresses[0].city}}\"\n },\n {\n \"key\": \"something\",\n \"value\": \"{{any liquid}}\"\n }\n ]\n}\n```\n\nThis will create variables `customerName`, `fullName`, `customerEmail`, `greeting`, and `something`. To access these variables, you can reference them as `{{customerName}}`, `{{fullName}}`, `{{customerEmail}}`, `{{greeting}}`, and `{{something}}`.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.","minLength":1,"maxLength":40,"pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"","maxLength":10000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.variableExtractionPlan","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"BashTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.1","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.displayHeightPx","typeLabel":"number"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.server","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.displayNumber","typeLabel":"number"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.2","typeLabel":"ComputerTool · object"},{"type":"object","title":"DtmfTool","required":["type"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.3","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.4","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"async":{"type":"boolean","example":false,"description":"This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`).","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.async","typeLabel":"boolean"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.5","typeLabel":"FunctionTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.availability.check"],"description":"The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.6","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.calendar.event.create"],"description":"The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.7","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.8","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.9","typeLabel":"GoHighLevelContactGetTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.availability.check"],"description":"The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.10","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.calendar.event.create"],"description":"The type of tool. \"google.calendar.event.create\" for Google Calendar tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.11","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type"],"properties":{"type":{"type":"string","enum":["google.sheets.row.append"],"description":"The type of tool. \"google.sheets.row.append\" for Google Sheets tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.12","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"McpTool","required":["type"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.server","typeLabel":"object"},"metadata":{"type":"object","properties":{"protocol":{"type":"string","enum":["sse","shttp"],"description":"This is the protocol used for MCP communication. Defaults to Streamable HTTP.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.metadata","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.13","typeLabel":"McpTool · object"},{"type":"object","title":"QueryTool","required":["type"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"knowledgeBases":{"description":"The knowledge bases to query","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the knowledge base","example":"My Knowledge Base","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].fileIds","typeLabel":"string[]"},"model":{"type":"string","description":"The model to use for the knowledge base","enum":["gemini-2.5-pro","gemini-2.5-flash","gemini-2.5-flash-lite","gemini-2.5-pro-preview-05-06","gemini-2.5-flash-preview-05-20","gemini-2.5-flash-preview-04-17","gemini-2.0-flash-thinking-exp","gemini-2.0-pro-exp-02-05","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.0-flash-lite-preview-02-05","gemini-2.0-flash-exp","gemini-2.0-flash-realtime-exp","gemini-1.5-flash","gemini-1.5-flash-002","gemini-1.5-pro","gemini-1.5-pro-002","gemini-1.0-pro"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.knowledgeBases","typeLabel":"object[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.14","typeLabel":"QueryTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsTool","required":["type"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.16","typeLabel":"SmsTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.subType","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.name","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"server":{"type":"object","description":"\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.server","typeLabel":"object"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.17","typeLabel":"TextEditorTool · object"},{"type":"object","title":"TransferCallTool","required":["type"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.type","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"any[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"any[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"any[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"any[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"destinations":{"type":"array","description":"These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.","items":{"oneOf":[{"type":"object","title":"Assistant","required":["type","assistantName"],"properties":{"type":{"type":"string","enum":["assistant"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"assistantName":{"type":"string","description":"This is the assistant to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.assistantName","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.message","typeLabel":"string | object"},"transferMode":{"type":"string","description":"This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'","enum":["rolling-history","swap-system-message-in-history","swap-system-message-in-history-and-remove-transfer-tool-messages","delete-history"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.transferMode","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"number":{"type":"string","description":"This is the phone number to transfer the call to.","minLength":3,"maxLength":40,"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.number","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.message","typeLabel":"string | object"},"numberE164CheckEnabled":{"type":"boolean","description":"This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)","default":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.numberE164CheckEnabled","typeLabel":"boolean"},"extension":{"type":"string","description":"This is the extension to dial after transferring the call to the `number`.","minLength":1,"maxLength":10,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.extension","typeLabel":"string"},"callerId":{"type":"string","description":"This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid","maxLength":40,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.callerId","typeLabel":"string"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.transferPlan","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"sipUri":{"type":"string","description":"This is the SIP URI to transfer the call to.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipUri","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.message","typeLabel":"string | object"},"transferPlan":{"type":"object","description":"This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`","required":["mode"],"properties":{"mode":{"type":"string","description":"This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'","enum":["blind-transfer","blind-transfer-add-summary-to-sip-header","warm-transfer-say-message","warm-transfer-say-summary","warm-transfer-twiml","warm-transfer-wait-for-operator-to-speak-first-and-then-say-message","warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary","warm-transfer-experimental"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.mode","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.message","typeLabel":"string | object"},"timeout":{"type":"number","description":"This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60","minimum":1,"maximum":600,"default":60,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.timeout","typeLabel":"number"},"sipVerb":{"type":"object","description":"This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call","default":"refer","enum":["refer","bye","dial"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipVerb","typeLabel":"object"},"holdAudioUrl":{"type":"string","description":"This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.holdAudioUrl","typeLabel":"string"},"transferCompleteAudioUrl":{"type":"string","description":"This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.transferCompleteAudioUrl","typeLabel":"string"},"twiml":{"type":"string","description":"This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\n\u003cSay voice=\"alice\" language=\"en-US\">Hello, transferring a customer to you.\u003c/Say>\n\u003cPause length=\"2\"/>\n\u003cSay>They called about billing questions.\u003c/Say>\n```","maxLength":4096,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.twiml","typeLabel":"string"},"summaryPlan":{"type":"object","description":"This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.","properties":{"messages":{"description":"These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`","type":"array","items":{"type":"object","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages","typeLabel":"object[]"},"enabled":{"type":"boolean","description":"This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.enabled","typeLabel":"boolean"},"timeoutSeconds":{"type":"number","description":"This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds","minimum":1,"maximum":60,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan","typeLabel":"object"},"sipHeadersInReferToEnabled":{"type":"boolean","description":"This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.sipHeadersInReferToEnabled","typeLabel":"boolean"},"fallbackPlan":{"type":"object","description":"This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.","required":["message"],"properties":{"message":{"oneOf":[{"type":"string","description":"This is the message the assistant will deliver to the customer if the transfer fails.","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.0","typeLabel":"string"},{"type":"object","description":"This is the message the assistant will deliver to the customer if the transfer fails.","required":["type"],"properties":{"type":{"type":"string","description":"This is a custom message.","enum":["custom-message"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"any","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"any"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"any[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message","typeLabel":"string | object"},"endCallEnabled":{"type":"boolean","description":"This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true","default":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.transferPlan","typeLabel":"object"},"sipHeaders":{"type":"object","description":"These are custom headers to be added to SIP refer during transfer call.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.sipHeaders","typeLabel":"object"},"description":{"type":"string","description":"This is the description of the destination, used by the AI to choose when and how to transfer the call.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.destinations","typeLabel":"(Assistant · object | Number · object | Sip · object)[]"},"function":{"type":"object","description":"This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.","required":["name"],"properties":{"name":{"type":"string","description":"This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","maxLength":64,"pattern":"/^[a-zA-Z0-9_-]{1,64}$/","isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18.function","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.tools.items.[INDEX].oneOf.18","typeLabel":"TransferCallTool · object"}],"uniqueKey":"model.oneOf.13.tools.items.[INDEX]","typeLabel":"ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object"},"uniqueKey":"model.oneOf.13.tools","typeLabel":"(ApiRequestTool · object | BashTool · object | ComputerTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object | GoogleCalendarCheckAvailabilityTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | McpTool · object | QueryTool · object | SlackSendMessageTool · object | SmsTool · object | TextEditorTool · object | TransferCallTool · object)[]"},"toolIds":{"description":"These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.","type":"array","items":{"type":"string","uniqueKey":"model.oneOf.13.toolIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"model.oneOf.13.toolIds","typeLabel":"string[]"},"knowledgeBase":{"type":"object","title":"Custom","description":"These are the options for the knowledge base.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This knowledge base is bring your own knowledge base implementation.","enum":["custom-knowledge-base"],"isRequired":true,"uniqueKey":"model.oneOf.13.knowledgeBase.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"model.oneOf.13.knowledgeBase.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"model.oneOf.13.knowledgeBase.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"model.oneOf.13.knowledgeBase.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"model.oneOf.13.knowledgeBase.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"model.oneOf.13.knowledgeBase.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"model.oneOf.13.knowledgeBase.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"model.oneOf.13.knowledgeBase.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"model.oneOf.13.knowledgeBase.server","typeLabel":"object"}},"uniqueKey":"model.oneOf.13.knowledgeBase","typeLabel":"Custom · object"},"knowledgeBaseId":{"type":"string","description":"This is the ID of the knowledge base the model will use.","uniqueKey":"model.oneOf.13.knowledgeBaseId","typeLabel":"string"},"temperature":{"type":"number","description":"This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.","minimum":0,"maximum":2,"uniqueKey":"model.oneOf.13.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.","minimum":50,"maximum":10000,"uniqueKey":"model.oneOf.13.maxTokens","typeLabel":"number"},"emotionRecognitionEnabled":{"type":"boolean","description":"This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text.\n\n@default false","uniqueKey":"model.oneOf.13.emotionRecognitionEnabled","typeLabel":"boolean"},"numFastTurns":{"type":"number","description":"This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0","minimum":0,"uniqueKey":"model.oneOf.13.numFastTurns","typeLabel":"number"}},"uniqueKey":"model.oneOf.13","typeLabel":"XAI · object"}],"uniqueKey":"model","typeLabel":"Anthropic · object | Anyscale · object | Cerebras · object | CustomLLM · object | DeepInfra · object | DeepSeek · object | Google · object | Groq · object | InflectionAI · object | OpenAI · object | OpenRouter · object | PerplexityAI · object | Together · object | XAI · object"},"voice":{"oneOf":[{"type":"object","title":"AzureVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.chunkPlan","typeLabel":"object"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.0.speed","typeLabel":"number"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.0.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.0.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.0.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.0","typeLabel":"AzureVoice · object"},{"type":"object","title":"CartesiaVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.1.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.1.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.1.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.1","typeLabel":"CartesiaVoice · object"},{"type":"object","title":"CustomVoice","description":"These are the options for the assistant's voice.","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.2.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.2.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.2.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.2.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.2.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.2.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.2.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.2.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.2.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.2.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.2.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.2.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.2","typeLabel":"CustomVoice · object"},{"type":"object","title":"DeepgramVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.3.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.3.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.3.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.3.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.3.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.3.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.3.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.3","typeLabel":"DeepgramVoice · object"},{"type":"object","title":"ElevenLabsVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.4.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.4.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.4.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.4.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.4.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.4.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.4.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.4.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.4.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.4.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.4.model","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.chunkPlan","typeLabel":"object"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.4.language","typeLabel":"string"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.4.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.4.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.4.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.4","typeLabel":"ElevenLabsVoice · object"},{"type":"object","title":"HumeVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.5.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.5.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.5.isCustomHumeVoice","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.chunkPlan","typeLabel":"object"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.5.description","typeLabel":"string"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.5.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.5.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.5.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.5","typeLabel":"HumeVoice · object"},{"type":"object","title":"LMNTVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.6.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.6.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.6.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.6.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.6.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.6.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.6.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.6.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.6","typeLabel":"LMNTVoice · object"},{"type":"object","title":"NeuphonicVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.7.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.7.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.7.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.9","typeLabel":"PlayHT · object"},{"type":"object","title":"RimeAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["rime-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["abbie","allison","ally","alona","amber","ana","antoine","armon","brenda","brittany","carol","colin","courtney","elena","elliot","eva","geoff","gerald","hank","helen","hera","jen","joe","joy","juan","kendra","kendrick","kenneth","kevin","kris","linda","madison","marge","marina","marissa","marta","maya","nicholas","nyles","phil","reba","rex","rick","ritu","rob","rodney","rohan","rosco","samantha","sandy","selena","seth","sharon","stan","tamra","tanya","tibur","tj","tyler","viv","yadira","marsh","bayou","creek","brook","flower","spore","glacier","gulch","alpine","cove","lagoon","tundra","steppe","mesa","grove","rainforest","moraine","wildflower","peak","boulder","gypsum","zest","luna","celeste","orion","ursa","astra","esther","estelle","andromeda"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"RimeAI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'mistv2' when not specified.","enum":["mist","mistv2","arcana"],"example":"mistv2","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.speed","typeLabel":"number"},"pauseBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. \u003c200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.pauseBetweenBrackets","typeLabel":"boolean"},"phonemizeBetweenBrackets":{"type":"boolean","description":"This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.phonemizeBetweenBrackets","typeLabel":"boolean"},"reduceLatency":{"type":"boolean","description":"This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency","example":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.reduceLatency","typeLabel":"boolean"},"inlineSpeedAlpha":{"type":"string","description":"This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha","example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.inlineSpeedAlpha","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.10","typeLabel":"RimeAI · object"},{"type":"object","title":"Smallest AI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["smallest-ai"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["emily","jasmine","arman","james","mithali","aravind","raj","diya","raman","ananya","isha","william","aarav","monika","niharika","deepika","raghav","kajal","radhika","mansi","nisha","saurabh","pooja","saina","sanya"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Smallest AI Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"Smallest AI voice model to use. Defaults to 'lightning' when not specified.","enum":["lightning"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.11","typeLabel":"Smallest AI · object"},{"type":"object","title":"TavusVoice","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["tavus"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["r52da2535a"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Tavus Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.cachingEnabled","typeLabel":"boolean"},"personaId":{"type":"string","description":"This is the unique identifier for the persona that the replica will use in the conversation.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.personaId","typeLabel":"string"},"callbackUrl":{"type":"string","description":"This is the url that will receive webhooks with updates regarding the conversation state.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.callbackUrl","typeLabel":"string"},"conversationName":{"type":"string","description":"This is the name for the conversation.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationName","typeLabel":"string"},"conversationalContext":{"type":"string","description":"This is the context that will be appended to any context provided in the persona, if one is provided.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.conversationalContext","typeLabel":"string"},"customGreeting":{"type":"string","description":"This is the custom greeting that the replica will give once a participant joines the conversation.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.customGreeting","typeLabel":"string"},"properties":{"type":"object","description":"These are optional properties used to customize the conversation.","properties":{"maxCallDuration":{"type":"number","description":"The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.maxCallDuration","typeLabel":"number"},"participantLeftTimeout":{"type":"number","description":"The duration in seconds after which the call will be automatically shut down once the last participant leaves.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantLeftTimeout","typeLabel":"number"},"participantAbsentTimeout":{"type":"number","description":"Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes).","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.participantAbsentTimeout","typeLabel":"number"},"enableRecording":{"type":"boolean","description":"If true, the user will be able to record the conversation.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableRecording","typeLabel":"boolean"},"enableTranscription":{"type":"boolean","description":"If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.enableTranscription","typeLabel":"boolean"},"applyGreenscreen":{"type":"boolean","description":"If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.applyGreenscreen","typeLabel":"boolean"},"language":{"type":"string","description":"The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.language","typeLabel":"string"},"recordingS3BucketName":{"type":"string","description":"The name of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketName","typeLabel":"string"},"recordingS3BucketRegion":{"type":"string","description":"The region of the S3 bucket where the recording will be stored.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.recordingS3BucketRegion","typeLabel":"string"},"awsAssumeRoleArn":{"type":"string","description":"The ARN of the role that will be assumed to access the S3 bucket.","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties.awsAssumeRoleArn","typeLabel":"string"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.properties","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.12","typeLabel":"TavusVoice · object"},{"type":"object","title":"Neuphonic","required":["provider","voiceId","language"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["neuphonic"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["test"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Neuphonic Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.voiceId","typeLabel":"enum\u003cstring> | string"},"language":{"type":"object","description":"This is the language (ISO 639-1) that is enforced for the model.","example":"en","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.language","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'neu_fast' if not specified.","enum":["neu_hq","neu_fast"],"example":"neu_fast","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.model","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.13","typeLabel":"Neuphonic · object"},{"type":"object","title":"Sesame","required":["provider","voiceId","model"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["sesame"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","title":"Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice).","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.voiceId","typeLabel":"string"},"model":{"type":"string","description":"This is the model that will be used.","enum":["csm-1b"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.model","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.14","typeLabel":"Sesame · object"},{"type":"object","title":"Inworld","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["inworld"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael","maxLength":120,"title":"Inworld Voice ID","enum":["Alex","Ashley","Craig","Deborah","Dennis","Edward","Elizabeth","Hades","Julia","Pixie","Mark","Olivia","Priya","Ronald","Sarah","Shaun","Theodore","Timothy","Wendy","Dominus","Yichen","Xiaoyin","Xinyi","Jing","Erik","Katrien","Lennart","Lore","Alain","Hélène","Mathieu","Étienne","Johanna","Josef","Gianni","Orietta","Asuka","Satoshi","Hyunwoo","Minji","Seojun","Yoona","Szymon","Wojciech","Heitor","Maitê","Diego","Lupita","Miguel","Rafael"],"example":"Alex","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["inworld-tts-1"],"default":"inworld-tts-1","uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.model","typeLabel":"enum\u003cstring>"},"languageCode":{"type":"string","description":"Language code for Inworld TTS synthesis","default":"en","enum":["en","zh","ko","nl","fr","es","ja","de","it","pl","pt"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.languageCode","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX].oneOf.15","typeLabel":"Inworld · object"}],"uniqueKey":"voice.oneOf.7.fallbackPlan.voices.items.[INDEX]","typeLabel":"Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object"},"isRequired":true,"uniqueKey":"voice.oneOf.7.fallbackPlan.voices","typeLabel":"(Azure · object | Cartesia · object | Hume · object | CustomVoice · object | Deepgram · object | ElevenLabs · object | cozmox · object | LMNT · object | OpenAI · object | PlayHT · object | RimeAI · object | Smallest AI · object | TavusVoice · object | Neuphonic · object | Sesame · object | Inworld · object)[]"}},"uniqueKey":"voice.oneOf.7.fallbackPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.7","typeLabel":"NeuphonicVoice · object"},{"type":"object","title":"OpenAIVoice","description":"These are the options for the assistant's voice.","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.chunkPlan","typeLabel":"object"},"fallbackPlan":{"type":"object","description":"This is the plan for voice provider fallbacks in the event that the primary voice provider fails.","required":["voices"],"properties":{"voices":{"type":"array","description":"This is the list of voices to fallback to in the event that the primary voice provider fails.","items":{"oneOf":[{"type":"object","title":"Azure","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["azure"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["andrew","brian","emma"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Azure Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.5,"maximum":2,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.0","typeLabel":"Azure · object"},{"type":"object","title":"Cartesia","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cartesia"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. This is optional and will default to the correct model for the voiceId.","enum":["sonic-2","sonic-english","sonic-multilingual","sonic-preview","sonic"],"example":"sonic-english","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language that will be used. This is optional and will default to the correct language for the voiceId.","enum":["en","de","es","fr","ja","pt","zh","hi","it","ko","nl","pl","ru","sv","tr"],"example":"en","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.language","typeLabel":"enum\u003cstring>"},"experimentalControls":{"type":"object","description":"Experimental controls for Cartesia voice generation","properties":{"speed":{"oneOf":[{"type":"string","enum":["slowest","slow","normal","fast","fastest"],"example":"normal","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","maximum":1,"minimum":-1,"example":0.5,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed.oneOf.1","typeLabel":"number"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.speed","typeLabel":"enum\u003cstring> | number"},"emotion":{"type":"string","enum":["anger:lowest","anger:low","anger:high","anger:highest","positivity:lowest","positivity:low","positivity:high","positivity:highest","surprise:lowest","surprise:low","surprise:high","surprise:highest","sadness:lowest","sadness:low","sadness:high","sadness:highest","curiosity:lowest","curiosity:low","curiosity:high","curiosity:highest"],"example":["happiness:high"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls.emotion","typeLabel":"enum\u003cstring>"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.experimentalControls","typeLabel":"object"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.1","typeLabel":"Cartesia · object"},{"type":"object","title":"Hume","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["hume"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The ID of the particular voice you want to use.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.voiceId","typeLabel":"string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used.","enum":["octave"],"example":"octave","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring>"},"isCustomHumeVoice":{"type":"boolean","description":"Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.","example":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.isCustomHumeVoice","typeLabel":"boolean"},"description":{"type":"string","description":"Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description.","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.description","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.2","typeLabel":"Hume · object"},{"type":"object","title":"CustomVoice","required":["provider","server"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.","enum":["custom-voice"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.provider","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```","properties":{"timeoutSeconds":{"type":"number","description":"This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20","minimum":1,"maximum":300,"example":20,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.url","typeLabel":"string"},"headers":{"type":"object","description":"These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.headers","typeLabel":"object"},"backoffPlan":{"type":"object","description":"This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)","required":["type","maxRetries","baseDelaySeconds"],"properties":{"type":{"type":"object","description":"This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed","enum":["fixed","exponential"],"example":"fixed","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.type","typeLabel":"object"},"maxRetries":{"type":"number","description":"This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0","minimum":0,"maximum":10,"example":0,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.maxRetries","typeLabel":"number"},"baseDelaySeconds":{"type":"number","description":"This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.","minimum":0,"maximum":10,"example":1,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server.backoffPlan","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.server","typeLabel":"object"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.cachingEnabled","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.3","typeLabel":"CustomVoice · object"},{"type":"object","title":"Deepgram","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["deepgram"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"This is the provider-specific ID that will be used.","enum":["asteria","luna","stella","athena","hera","orion","arcas","perseus","angus","orpheus","helios","zeus","thalia","andromeda","helena","apollo","arcas","aries","amalthea","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","selene","theia","vesta","zeus"],"title":"This is the Deepgram Voice ID","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'aura-2' when not specified.","enum":["aura","aura-2"],"example":"aura-2","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.model","typeLabel":"enum\u003cstring>"},"mipOptOut":{"type":"boolean","description":"If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false","example":false,"default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.mipOptOut","typeLabel":"boolean"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.4","typeLabel":"Deepgram · object"},{"type":"object","title":"ElevenLabs","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["11labs"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","enum":["burt","marissa","andrea","sarah","phillip","steve","joseph","myra","paula","ryan","drew","paul","mrb","matilda","mark"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"11Labs Voice ID","description":"This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.cachingEnabled","typeLabel":"boolean"},"stability":{"type":"number","description":"Defines the stability for voice settings.","minimum":0,"maximum":1,"example":0.5,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.stability","typeLabel":"number"},"similarityBoost":{"type":"number","description":"Defines the similarity boost for voice settings.","minimum":0,"maximum":1,"example":0.75,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.similarityBoost","typeLabel":"number"},"style":{"type":"number","description":"Defines the style for voice settings.","minimum":0,"maximum":1,"example":0,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.style","typeLabel":"number"},"useSpeakerBoost":{"type":"boolean","description":"Defines the use speaker boost for voice settings.","example":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.useSpeakerBoost","typeLabel":"boolean"},"speed":{"type":"number","description":"Defines the speed for voice settings.","minimum":0.7,"maximum":1.2,"example":0.9,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.speed","typeLabel":"number"},"optimizeStreamingLatency":{"type":"number","description":"Defines the optimize streaming latency for voice settings. Defaults to 3.","minimum":0,"maximum":4,"example":3,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.optimizeStreamingLatency","typeLabel":"number"},"enableSsmlParsing":{"type":"boolean","description":"This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false","example":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.enableSsmlParsing","typeLabel":"boolean"},"autoMode":{"type":"boolean","description":"Defines the auto mode for voice settings. Defaults to false.","example":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.autoMode","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.","enum":["eleven_multilingual_v2","eleven_turbo_v2","eleven_turbo_v2_5","eleven_flash_v2","eleven_flash_v2_5","eleven_monolingual_v1"],"example":"eleven_turbo_v2_5","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided.","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.language","typeLabel":"string"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.5","typeLabel":"ElevenLabs · object"},{"type":"object","title":"cozmox","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["cozmox"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"type":"string","description":"The voices provided by cozmox","enum":["Elliot","Kylie","Rohan","Lily","Savannah","Hana","Neha","Cole","Harry","Paige","Spencer"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.voiceId","typeLabel":"enum\u003cstring>"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.\n\n@default 1","minimum":0.25,"maximum":2,"default":1,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.6","typeLabel":"cozmox · object"},{"type":"object","title":"LMNT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["lmnt"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["amy","ansel","autumn","ava","brandon","caleb","cassian","chloe","dalton","daniel","dustin","elowen","evander","huxley","james","juniper","kennedy","lauren","leah","lily","lucas","magnus","miles","morgan","natalie","nathan","noah","nyssa","oliver","paige","ryan","sadie","sophie","stella","terrence","tyler","vesper","violet","warrick","zain","zeke","zoe"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"LMNT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.speed","typeLabel":"number"},"language":{"oneOf":[{"type":"string","title":"ISO 639-1 Language Code","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yue","yo","za","zh","zu"],"example":"en","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Auto-detect","description":"Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.","enum":["auto"],"example":"en","uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.language.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.7","typeLabel":"LMNT · object"},{"type":"object","title":"OpenAI","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["openai"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","enum":["alloy","echo","fable","onyx","nova","shimmer"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"OpenAI Voice ID","description":"This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.cachingEnabled","typeLabel":"boolean"},"model":{"type":"string","description":"This is the model that will be used for text-to-speech.","enum":["tts-1","tts-1-hd","gpt-4o-mini-tts"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.model","typeLabel":"enum\u003cstring>"},"instructions":{"type":"string","description":"This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.","maxLength":10000,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.instructions","typeLabel":"string"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.25,"maximum":4,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.speed","typeLabel":"number"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.value","typeLabel":"string"},"replaceAllEnabled":{"type":"boolean","description":"This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false","default":false,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.replaceAllEnabled","typeLabel":"boolean"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0","typeLabel":"ExactReplacement · object"},{"type":"object","title":"RegexReplacement","required":["type","regex","value"],"properties":{"type":{"type":"string","description":"This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?\u003c=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }","enum":["regex"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"regex":{"type":"string","description":"This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.regex","typeLabel":"string"},"value":{"type":"string","description":"This is the value that will replace the match.","maxLength":1000,"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.value","typeLabel":"string"},"options":{"description":"These are the options for the regex replacement. Defaults to all disabled.\n\n@default []","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.","enum":["ignore-case","whole-word","multi-line"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"This is whether to enable the option.\n\n@default false","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["type","enabled"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1.options","typeLabel":"object[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.1","typeLabel":"RegexReplacement · object"}],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements.items.[INDEX]","typeLabel":"ExactReplacement · object | RegexReplacement · object"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.replacements","typeLabel":"(ExactReplacement · object | RegexReplacement · object)[]"},"formattersEnabled":{"type":"array","description":"List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"items":{"type":"string","enum":["markdown","asterisk","quote","dash","newline","colon","acronym","dollarAmount","email","date","time","distance","unit","percentage","phoneNumber","number","stripAsterisk"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan.formattersEnabled","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan.formatPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8.chunkPlan","typeLabel":"object"}},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.8","typeLabel":"OpenAI · object"},{"type":"object","title":"PlayHT","required":["provider","voiceId"],"properties":{"provider":{"type":"string","description":"This is the voice provider that will be used.","enum":["playht"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.provider","typeLabel":"enum\u003cstring>"},"voiceId":{"oneOf":[{"type":"string","title":"Preset Voice Options","description":"This is the provider-specific ID that will be used.","enum":["jennifer","melissa","will","chris","matt","jack","ruby","davis","donna","michael"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"PlayHT Voice ID","description":"This is the provider-specific ID that will be used.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceId","typeLabel":"enum\u003cstring> | string"},"cachingEnabled":{"type":"boolean","description":"This is the flag to toggle voice caching for the assistant.","example":true,"default":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.cachingEnabled","typeLabel":"boolean"},"speed":{"type":"number","description":"This is the speed multiplier that will be used.","minimum":0.1,"maximum":5,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.speed","typeLabel":"number"},"temperature":{"type":"number","description":"A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.","minimum":0.1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.temperature","typeLabel":"number"},"emotion":{"type":"string","description":"An emotion to be applied to the speech.","enum":["female_happy","female_sad","female_angry","female_fearful","female_disgust","female_surprised","male_happy","male_sad","male_angry","male_fearful","male_disgust","male_surprised"],"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.emotion","typeLabel":"enum\u003cstring>"},"voiceGuidance":{"type":"number","description":"A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.","minimum":1,"maximum":6,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.voiceGuidance","typeLabel":"number"},"styleGuidance":{"type":"number","description":"A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.","minimum":1,"maximum":30,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.styleGuidance","typeLabel":"number"},"textGuidance":{"type":"number","description":"A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.","minimum":1,"maximum":2,"example":null,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.textGuidance","typeLabel":"number"},"model":{"type":"string","description":"Playht voice model/engine to use.","enum":["PlayHT2.0","PlayHT2.0-turbo","Play3.0-mini","PlayDialog"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"The language to use for the speech.","enum":["afrikaans","albanian","amharic","arabic","bengali","bulgarian","catalan","croatian","czech","danish","dutch","english","french","galician","german","greek","hebrew","hindi","hungarian","indonesian","italian","japanese","korean","malay","mandarin","polish","portuguese","russian","serbian","spanish","swedish","tagalog","thai","turkish","ukrainian","urdu","xhosa"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.language","typeLabel":"enum\u003cstring>"},"chunkPlan":{"type":"object","description":"This is the plan for chunking the model output before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, cozmox-provided audio control tokens like \u003cflush /> will not work.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.enabled","typeLabel":"boolean"},"minCharacters":{"type":"number","description":"This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30","minimum":1,"maximum":80,"example":30,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.minCharacters","typeLabel":"number"},"punctuationBoundaries":{"type":"array","description":"These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"example":["。",",",".","!","?",";","،","۔","।","॥","|","||",",",":"],"items":{"type":"string","enum":["。",",",".","!","?",";",")","،","۔","।","॥","|","||",",",":"],"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.punctuationBoundaries","typeLabel":"enum\u003cstring>[]"},"formatPlan":{"type":"object","description":"This is the plan for formatting the chunk before it is sent to the voice provider.","properties":{"enabled":{"type":"boolean","description":"This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true","example":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.enabled","typeLabel":"boolean"},"numberToDigitsCutoff":{"type":"number","description":"This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025","minimum":0,"example":2025,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.numberToDigitsCutoff","typeLabel":"number"},"replacements":{"type":"array","description":"These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []","items":{"oneOf":[{"type":"object","title":"ExactReplacement","required":["type","key","value"],"properties":{"type":{"type":"string","description":"This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'cozmox', value: 'Vappy' }","enum":["exact"],"isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan.replacements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"This is the key to replace.","isRequired":true,"uniqueKey":"voice.oneOf.8.fallbackPlan.voices.items.[INDEX].oneOf.9.chunkPlan.formatPlan